


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Index &mdash; pytorch-fm 0.1 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script type="text/javascript" src="_static/jquery.js"></script>
        <script type="text/javascript" src="_static/underscore.js"></script>
        <script type="text/javascript" src="_static/doctools.js"></script>
        <script type="text/javascript" src="_static/language_data.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="#" />
    <link rel="search" title="Search" href="search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="index.html" class="icon icon-home"> pytorch-fm
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="torchfm.html">torchfm package</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">pytorch-fm</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>Index</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#A"><strong>A</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#D"><strong>D</strong></a>
 | <a href="#E"><strong>E</strong></a>
 | <a href="#F"><strong>F</strong></a>
 | <a href="#I"><strong>I</strong></a>
 | <a href="#L"><strong>L</strong></a>
 | <a href="#M"><strong>M</strong></a>
 | <a href="#N"><strong>N</strong></a>
 | <a href="#O"><strong>O</strong></a>
 | <a href="#P"><strong>P</strong></a>
 | <a href="#T"><strong>T</strong></a>
 | <a href="#W"><strong>W</strong></a>
 
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.html#torchfm.layer.AttentionalFactorizationMachine">AttentionalFactorizationMachine (class in torchfm.layer)</a>
</li>
      <li><a href="torchfm.model.html#torchfm.model.afm.AttentionalFactorizationMachineModel">AttentionalFactorizationMachineModel (class in torchfm.model.afm)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.model.html#torchfm.model.afi.AutomaticFeatureInteractionModel">AutomaticFeatureInteractionModel (class in torchfm.model.afi)</a>
</li>
      <li><a href="torchfm.dataset.html#torchfm.dataset.avazu.AvazuDataset">AvazuDataset (class in torchfm.dataset.avazu)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.html#torchfm.layer.CompressedInteractionNetwork">CompressedInteractionNetwork (class in torchfm.layer)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.dataset.html#torchfm.dataset.criteo.CriteoDataset">CriteoDataset (class in torchfm.dataset.criteo)</a>
</li>
      <li><a href="torchfm.html#torchfm.layer.CrossNetwork">CrossNetwork (class in torchfm.layer)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.model.html#torchfm.model.dcn.DeepCrossNetworkModel">DeepCrossNetworkModel (class in torchfm.model.dcn)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.model.html#torchfm.model.dfm.DeepFactorizationMachineModel">DeepFactorizationMachineModel (class in torchfm.model.dfm)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.model.html#torchfm.model.xdfm.ExtremeDeepFactorizationMachineModel">ExtremeDeepFactorizationMachineModel (class in torchfm.model.xdfm)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.html#torchfm.layer.FactorizationMachine">FactorizationMachine (class in torchfm.layer)</a>
</li>
      <li><a href="torchfm.model.html#torchfm.model.fm.FactorizationMachineModel">FactorizationMachineModel (class in torchfm.model.fm)</a>
</li>
      <li><a href="torchfm.model.html#torchfm.model.fnn.FactorizationSupportedNeuralNetworkModel">FactorizationSupportedNeuralNetworkModel (class in torchfm.model.fnn)</a>
</li>
      <li><a href="torchfm.html#torchfm.layer.FeaturesEmbedding">FeaturesEmbedding (class in torchfm.layer)</a>
</li>
      <li><a href="torchfm.html#torchfm.layer.FeaturesLinear">FeaturesLinear (class in torchfm.layer)</a>
</li>
      <li><a href="torchfm.html#torchfm.layer.FieldAwareFactorizationMachine">FieldAwareFactorizationMachine (class in torchfm.layer)</a>
</li>
      <li><a href="torchfm.model.html#torchfm.model.ffm.FieldAwareFactorizationMachineModel">FieldAwareFactorizationMachineModel (class in torchfm.model.ffm)</a>
</li>
      <li><a href="torchfm.model.html#torchfm.model.fnfm.FieldAwareNeuralFactorizationMachineModel">FieldAwareNeuralFactorizationMachineModel (class in torchfm.model.fnfm)</a>
</li>
      <li><a href="torchfm.html#torchfm.layer.AttentionalFactorizationMachine.forward">forward() (torchfm.layer.AttentionalFactorizationMachine method)</a>

      <ul>
        <li><a href="torchfm.html#torchfm.layer.CompressedInteractionNetwork.forward">(torchfm.layer.CompressedInteractionNetwork method)</a>
</li>
        <li><a href="torchfm.html#torchfm.layer.CrossNetwork.forward">(torchfm.layer.CrossNetwork method)</a>
</li>
        <li><a href="torchfm.html#torchfm.layer.FactorizationMachine.forward">(torchfm.layer.FactorizationMachine method)</a>
</li>
        <li><a href="torchfm.html#torchfm.layer.FeaturesEmbedding.forward">(torchfm.layer.FeaturesEmbedding method)</a>
</li>
        <li><a href="torchfm.html#torchfm.layer.FeaturesLinear.forward">(torchfm.layer.FeaturesLinear method)</a>
</li>
        <li><a href="torchfm.html#torchfm.layer.FieldAwareFactorizationMachine.forward">(torchfm.layer.FieldAwareFactorizationMachine method)</a>
</li>
        <li><a href="torchfm.html#torchfm.layer.InnerProductNetwork.forward">(torchfm.layer.InnerProductNetwork method)</a>
</li>
        <li><a href="torchfm.html#torchfm.layer.MultiLayerPerceptron.forward">(torchfm.layer.MultiLayerPerceptron method)</a>
</li>
        <li><a href="torchfm.html#torchfm.layer.OuterProductNetwork.forward">(torchfm.layer.OuterProductNetwork method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.afi.AutomaticFeatureInteractionModel.forward">(torchfm.model.afi.AutomaticFeatureInteractionModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.afm.AttentionalFactorizationMachineModel.forward">(torchfm.model.afm.AttentionalFactorizationMachineModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.dcn.DeepCrossNetworkModel.forward">(torchfm.model.dcn.DeepCrossNetworkModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.dfm.DeepFactorizationMachineModel.forward">(torchfm.model.dfm.DeepFactorizationMachineModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.ffm.FieldAwareFactorizationMachineModel.forward">(torchfm.model.ffm.FieldAwareFactorizationMachineModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.fm.FactorizationMachineModel.forward">(torchfm.model.fm.FactorizationMachineModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.fnfm.FieldAwareNeuralFactorizationMachineModel.forward">(torchfm.model.fnfm.FieldAwareNeuralFactorizationMachineModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.fnn.FactorizationSupportedNeuralNetworkModel.forward">(torchfm.model.fnn.FactorizationSupportedNeuralNetworkModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.lr.LogisticRegressionModel.forward">(torchfm.model.lr.LogisticRegressionModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.nfm.NeuralFactorizationMachineModel.forward">(torchfm.model.nfm.NeuralFactorizationMachineModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.pnn.ProductNeuralNetworkModel.forward">(torchfm.model.pnn.ProductNeuralNetworkModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.wd.WideAndDeepModel.forward">(torchfm.model.wd.WideAndDeepModel method)</a>
</li>
        <li><a href="torchfm.model.html#torchfm.model.xdfm.ExtremeDeepFactorizationMachineModel.forward">(torchfm.model.xdfm.ExtremeDeepFactorizationMachineModel method)</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.html#torchfm.layer.InnerProductNetwork">InnerProductNetwork (class in torchfm.layer)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.model.html#torchfm.model.lr.LogisticRegressionModel">LogisticRegressionModel (class in torchfm.model.lr)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.dataset.html#torchfm.dataset.movielens.MovieLens1MDataset">MovieLens1MDataset (class in torchfm.dataset.movielens)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.dataset.html#torchfm.dataset.movielens.MovieLens20MDataset">MovieLens20MDataset (class in torchfm.dataset.movielens)</a>
</li>
      <li><a href="torchfm.html#torchfm.layer.MultiLayerPerceptron">MultiLayerPerceptron (class in torchfm.layer)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.model.html#torchfm.model.nfm.NeuralFactorizationMachineModel">NeuralFactorizationMachineModel (class in torchfm.model.nfm)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.html#torchfm.layer.OuterProductNetwork">OuterProductNetwork (class in torchfm.layer)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.model.html#torchfm.model.pnn.ProductNeuralNetworkModel">ProductNeuralNetworkModel (class in torchfm.model.pnn)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.dataset.html#module-torchfm.dataset.avazu">torchfm.dataset.avazu (module)</a>
</li>
      <li><a href="torchfm.dataset.html#module-torchfm.dataset.criteo">torchfm.dataset.criteo (module)</a>
</li>
      <li><a href="torchfm.dataset.html#module-torchfm.dataset.movielens">torchfm.dataset.movielens (module)</a>
</li>
      <li><a href="torchfm.html#module-torchfm.layer">torchfm.layer (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.afi">torchfm.model.afi (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.afm">torchfm.model.afm (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.dcn">torchfm.model.dcn (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.dfm">torchfm.model.dfm (module)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.model.html#module-torchfm.model.ffm">torchfm.model.ffm (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.fm">torchfm.model.fm (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.fnfm">torchfm.model.fnfm (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.fnn">torchfm.model.fnn (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.lr">torchfm.model.lr (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.nfm">torchfm.model.nfm (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.pnn">torchfm.model.pnn (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.wd">torchfm.model.wd (module)</a>
</li>
      <li><a href="torchfm.model.html#module-torchfm.model.xdfm">torchfm.model.xdfm (module)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="torchfm.model.html#torchfm.model.wd.WideAndDeepModel">WideAndDeepModel (class in torchfm.model.wd)</a>
</li>
  </ul></td>
</tr></table>



           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2019, rixwew@gmail.com

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>